<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Reranker Framework (ReFr): reranker::CandidateSetReader Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Reranker Framework (ReFr)
   
   </div>
   <div id="projectbrief">Reranking framework for structure prediction and discriminative language modeling</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespacereranker.html">reranker</a>      </li>
      <li class="navelem"><a class="el" href="classreranker_1_1_candidate_set_reader.html">CandidateSetReader</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">reranker::CandidateSetReader Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="reranker::CandidateSetReader" -->
<p>A class for reading streams of training or test instances, where each training or test instance is a <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">reranker::CandidateSet</a> object.  
 <a href="classreranker_1_1_candidate_set_reader.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>&gt;</code></p>

<p><a href="classreranker_1_1_candidate_set_reader-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#a5da309ab0f14c02a3d237b64dedfdd97">CandidateSetReader</a> (long reporting_interval=100)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new instance.  <a href="#a5da309ab0f14c02a3d237b64dedfdd97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#a44f8ba2b5bbd12134bd7d42375ea390e">CandidateSetReader</a> (int max_num_to_read, int max_candidates_per_set, long reporting_interval=100)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#ae84e3289cc6f6ce1e02602364316cb78">~CandidateSetReader</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#a50c5cabde0a721417272e14b7b755f40">Open</a> (const string &amp;filename, bool compressed, bool use_base64, bool reset_counters=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#afa8d2312498eb123c00796dbc2dd087a">Read</a> (const string &amp;filename, bool compressed, bool use_base64, bool reset_counters, vector&lt; shared_ptr&lt; <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> &gt; &gt; &amp;examples)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a stream of <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">CandidateSet</a> instances from the specified file or from standard input.  <a href="#afa8d2312498eb123c00796dbc2dd087a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">shared_ptr&lt; <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#ad16cad795b1c56cfbf8921309362391f">ReadNext</a> (bool &amp;reader_valid)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#a0d82d6e2dbef48297556d0b0ec5d9ffb">Close</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#adf4630c93ea0ec46e973f7016aa7bb27">Reset</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets this reader so that its internal count of the number of <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">CandidateSet</a>&rsquo;s read goes back to zero.  <a href="#adf4630c93ea0ec46e973f7016aa7bb27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#a7288ad426c48448041df81e2be1595bf">ClearStrings</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes <a class="el" href="classreranker_1_1_candidate_set_proto_reader.html#ac6fef2bb47660a680a18149af6811d24">CandidateSetProtoReader::ClearStrings</a> on the internal <a class="el" href="classreranker_1_1_candidate_set_proto_reader.html">CandidateSetProtoReader</a> instance.  <a href="#a7288ad426c48448041df81e2be1595bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#a7e00605dc435676105c28730554c2c09">num_read</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances read since the last invocation of the <a class="el" href="classreranker_1_1_candidate_set_reader.html#adf4630c93ea0ec46e973f7016aa7bb27">Reset</a> method.  <a href="#a7e00605dc435676105c28730554c2c09"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#aca3e5ee1a9fc951ab621942e3089bce6">total_num_read</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total number of <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances read.  <a href="#aca3e5ee1a9fc951ab621942e3089bce6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classreranker_1_1_candidate_set_reader.html#a46df40e5ad98bdee0bb0a552512349d5">set_verbosity</a> (int verbosity)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the verbosity of this reader (mostly for debugging purposes).  <a href="#a46df40e5ad98bdee0bb0a552512349d5"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class for reading streams of training or test instances, where each training or test instance is a <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">reranker::CandidateSet</a> object. </p>

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00062">62</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5da309ab0f14c02a3d237b64dedfdd97"></a><!-- doxytag: member="reranker::CandidateSetReader::CandidateSetReader" ref="a5da309ab0f14c02a3d237b64dedfdd97" args="(long reporting_interval=100)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classreranker_1_1_candidate_set_reader.html#a5da309ab0f14c02a3d237b64dedfdd97">reranker::CandidateSetReader::CandidateSetReader</a> </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>reporting_interval</em> = <code>100</code></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructs a new instance. </p>

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00065">65</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="a44f8ba2b5bbd12134bd7d42375ea390e"></a><!-- doxytag: member="reranker::CandidateSetReader::CandidateSetReader" ref="a44f8ba2b5bbd12134bd7d42375ea390e" args="(int max_num_to_read, int max_candidates_per_set, long reporting_interval=100)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classreranker_1_1_candidate_set_reader.html#a5da309ab0f14c02a3d237b64dedfdd97">reranker::CandidateSetReader::CandidateSetReader</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>max_num_to_read</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>max_candidates_per_set</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>reporting_interval</em> = <code>100</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00074">74</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="ae84e3289cc6f6ce1e02602364316cb78"></a><!-- doxytag: member="reranker::CandidateSetReader::~CandidateSetReader" ref="ae84e3289cc6f6ce1e02602364316cb78" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classreranker_1_1_candidate_set_reader.html#ae84e3289cc6f6ce1e02602364316cb78">reranker::CandidateSetReader::~CandidateSetReader</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00085">85</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7288ad426c48448041df81e2be1595bf"></a><!-- doxytag: member="reranker::CandidateSetReader::ClearStrings" ref="a7288ad426c48448041df81e2be1595bf" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_candidate_set_reader.html#a7288ad426c48448041df81e2be1595bf">reranker::CandidateSetReader::ClearStrings</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Invokes <a class="el" href="classreranker_1_1_candidate_set_proto_reader.html#ac6fef2bb47660a680a18149af6811d24">CandidateSetProtoReader::ClearStrings</a> on the internal <a class="el" href="classreranker_1_1_candidate_set_proto_reader.html">CandidateSetProtoReader</a> instance. </p>

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00195">195</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="a0d82d6e2dbef48297556d0b0ec5d9ffb"></a><!-- doxytag: member="reranker::CandidateSetReader::Close" ref="a0d82d6e2dbef48297556d0b0ec5d9ffb" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_candidate_set_reader.html#a0d82d6e2dbef48297556d0b0ec5d9ffb">reranker::CandidateSetReader::Close</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00176">176</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="a7e00605dc435676105c28730554c2c09"></a><!-- doxytag: member="reranker::CandidateSetReader::num_read" ref="a7e00605dc435676105c28730554c2c09" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">long <a class="el" href="classreranker_1_1_candidate_set_reader.html#a7e00605dc435676105c28730554c2c09">reranker::CandidateSetReader::num_read</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the number of <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances read since the last invocation of the <a class="el" href="classreranker_1_1_candidate_set_reader.html#adf4630c93ea0ec46e973f7016aa7bb27">Reset</a> method. </p>

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00203">203</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="a50c5cabde0a721417272e14b7b755f40"></a><!-- doxytag: member="reranker::CandidateSetReader::Open" ref="a50c5cabde0a721417272e14b7b755f40" args="(const string &amp;filename, bool compressed, bool use_base64, bool reset_counters=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_candidate_set_reader.html#a50c5cabde0a721417272e14b7b755f40">reranker::CandidateSetReader::Open</a> </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>compressed</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>use_base64</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>reset_counters</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00087">87</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="afa8d2312498eb123c00796dbc2dd087a"></a><!-- doxytag: member="reranker::CandidateSetReader::Read" ref="afa8d2312498eb123c00796dbc2dd087a" args="(const string &amp;filename, bool compressed, bool use_base64, bool reset_counters, vector&lt; shared_ptr&lt; CandidateSet &gt; &gt; &amp;examples)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_candidate_set_reader.html#afa8d2312498eb123c00796dbc2dd087a">reranker::CandidateSetReader::Read</a> </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>compressed</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>use_base64</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>reset_counters</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">vector&lt; shared_ptr&lt; <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> &gt; &gt; &amp;&#160;</td>
          <td class="paramname"><em>examples</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reads a stream of <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">CandidateSet</a> instances from the specified file or from standard input. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>the filename from which to read; specify <code>"-"</code> to read from standard input </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">compressed</td><td>whether the input stream is compressed </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">use_base64</td><td>whether to do base64 decoding </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">reset_counters</td><td>whether to invoke <a class="el" href="classreranker_1_1_candidate_set_reader.html#adf4630c93ea0ec46e973f7016aa7bb27">Reset</a> prior to opening the specified file </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">examples</td><td>the vector of pointers to <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">CandidateSet</a> instances to which to append (pointers to) newly-read and -constructed <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">CandidateSet</a> instances </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00118">118</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="ad16cad795b1c56cfbf8921309362391f"></a><!-- doxytag: member="reranker::CandidateSetReader::ReadNext" ref="ad16cad795b1c56cfbf8921309362391f" args="(bool &amp;reader_valid)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">shared_ptr&lt;<a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a>&gt; <a class="el" href="classreranker_1_1_candidate_set_reader.html#ad16cad795b1c56cfbf8921309362391f">reranker::CandidateSetReader::ReadNext</a> </td>
          <td>(</td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>reader_valid</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00136">136</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="adf4630c93ea0ec46e973f7016aa7bb27"></a><!-- doxytag: member="reranker::CandidateSetReader::Reset" ref="adf4630c93ea0ec46e973f7016aa7bb27" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_candidate_set_reader.html#adf4630c93ea0ec46e973f7016aa7bb27">reranker::CandidateSetReader::Reset</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Resets this reader so that its internal count of the number of <a class="el" href="classreranker_1_1_candidate_set.html" title="A class to hold a set of candidates, either for training or test.">CandidateSet</a>&rsquo;s read goes back to zero. </p>

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00188">188</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="a46df40e5ad98bdee0bb0a552512349d5"></a><!-- doxytag: member="reranker::CandidateSetReader::set_verbosity" ref="a46df40e5ad98bdee0bb0a552512349d5" args="(int verbosity)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classreranker_1_1_candidate_set_reader.html#a46df40e5ad98bdee0bb0a552512349d5">reranker::CandidateSetReader::set_verbosity</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>verbosity</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the verbosity of this reader (mostly for debugging purposes). </p>
<p>There are currently four levels: </p>
<table class="doxtable">
<tr>
<th>Level</th><th>Meaning </th></tr>
<tr>
<td>0 </td><td>None </td></tr>
<tr>
<td>1 </td><td>Basic output </td></tr>
<tr>
<td>2 </td><td>Very verbose output </td></tr>
<tr>
<td>3 </td><td>Extremely verbose output </td></tr>
</table>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">verbosity</td><td>the new verbosity level for this reader to have </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00221">221</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<a class="anchor" id="aca3e5ee1a9fc951ab621942e3089bce6"></a><!-- doxytag: member="reranker::CandidateSetReader::total_num_read" ref="aca3e5ee1a9fc951ab621942e3089bce6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">long <a class="el" href="classreranker_1_1_candidate_set_reader.html#aca3e5ee1a9fc951ab621942e3089bce6">reranker::CandidateSetReader::total_num_read</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the total number of <a class="el" href="classreranker_1_1_candidate_set.html">CandidateSet</a> instances read. </p>

<p>Definition at line <a class="el" href="candidate-set-reader_8_h_source.html#l00206">206</a> of file <a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="candidate-set-reader_8_h_source.html">candidate-set-reader.H</a></li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Tue Jan 7 2014 15:24:58 for Reranker Framework (ReFr) by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
